refactor: update to work with latest openedx_content container changes [FC-0117] by bradenmacdonald · Pull Request #38181 · openedx/openedx-platform

bradenmacdonald · 2026-03-17T03:26:39Z

Description

Thanks to the changes in openedx/openedx-core#495 , we can simplify a lot of the container-related code in the content libraries API.

Supporting information

See openedx/openedx-core#412

Testing instructions

Ensure that content libraries are working as normal - create components and containers, use them in courses, etc.

Deadline

Verawood

openedx-webhooks · 2026-03-17T03:26:45Z

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

openedx-webhooks · 2026-03-17T03:26:45Z

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

kdmccormick

Some nice cleanup 🔥

Do you mind pushing the temporary version bumps so that the sandbox builds?

kdmccormick · 2026-03-19T19:21:59Z

cms/djangoapps/contentstore/xblock_storage_handlers/view_handlers.py

+                    # convert "unit" -> "vertical", "subsection" -> "sequential"
+                    block_type = content_api.get_container_type(upstream_child.container_type_code).olx_tag_name
+                    if not block_type or block_type not in ("vertical", "sequential"):


Suggested change

# convert "unit" -> "vertical", "subsection" -> "sequential"

block_type = content_api.get_container_type(upstream_child.container_type_code).olx_tag_name

if not block_type or block_type not in ("vertical", "sequential"):

if upstream_child.container_type_code not in (Unit.type_code, Subsection.type_code):

What do you think about learning towards <ContainerSubclass>.type_code as the canonical way to check type codes?

I think, in general, we could lean away from the olx tags except for when we really need them (serialization/deserialization). Especially since the ContainerKeys don't even use those olx codes.

kdmccormick · 2026-03-19T19:27:40Z

openedx/core/djangoapps/content/search/tests/test_api.py

            self.unit = library_api.create_container(
                library_key=self.library.key,
-                container_type=library_api.ContainerType.Unit,
+                container_type=content_models.Unit,


I think that either the pararm container_type: ContainerType needs to become container_subclass: type[Container], or arg value needs to become content_models.Unit.get_container_type().

kdmccormick · 2026-03-19T19:28:33Z

openedx/core/djangoapps/content_libraries/api/container_metadata.py

 ]

+# For now, we only allow the following types of containers in content libraries, and their hierarchy is hard-coded.
+LIBRARY_ALLOWED_CONTAINER_TYPES = ["unit", "subsection", "section"]


Suggested change

LIBRARY_ALLOWED_CONTAINER_TYPES = ["unit", "subsection", "section"]

LIBRARY_ALLOWED_CONTAINER_TYPES = [Unit.type_code, Subsection.type_code, Section.type]

Maybe we avoid using the string names directly?

kdmccormick · 2026-03-19T19:35:53Z

openedx/core/djangoapps/content_libraries/api/containers.py

+    container, _initial_version = content_api.create_container_and_version(
+        content_library.learning_package_id,
+        key=slug,
+        title=title,
+        container_type=container_type,
+        entities=[],
+        created=created,
+        created_by=user_id,
+    )


:chefskiss:

kdmccormick · 2026-03-19T19:59:49Z

openedx/core/djangoapps/content_libraries/rest_api/serializers.py

    """
-    # Use 'source' to get this as a string, not an enum value instance which the container_type field has.
+    container_type_code = serializers.CharField(source="container_key.container_type")
+    # Deprecated - ambiguous type


Suggested change

# Deprecated - ambiguous type

# Deprecated (ambiguously named). Identical to container_type_code.

kdmccormick · 2026-03-19T20:11:24Z

openedx/core/djangoapps/content_libraries/api/containers.py

+    children = get_container_children(container_key, published=False)
+    child_key_name = "usage_key" if isinstance(container, Unit) else "container_key"


I know this is existing code, but I really dislike getattr and my experience is that others devs see its usage and replicate it because it's fewer keystrokes than the equivalent more-typesafe code.

Would you consider dropping child_key_name and changing:

object_id=str(getattr(child, child_key_name)),

to

object_id=str(child.usage_key if isinstance(container, Unit) else child.container_key),

?

(Tangentially, I think this code an indication that we need some shared idea of "entity_key"--not PublishableEntity.key--which encompasses both component usage keys and container keys.)

kdmccormick · 2026-03-19T20:12:35Z

openedx/core/djangoapps/content_libraries/api/container_metadata.py



 @dataclass(frozen=True, kw_only=True)
 class ContainerMetadata(PublishableItem):


Not an issue for this PR, but I'd love to eventually push these dataclasses down into openedx-core.

refactor: update to work with latest openedx_content container changes

9a24f83

bradenmacdonald added the FC Relates to an Axim Funded Contribution project label Mar 17, 2026

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Mar 17, 2026

openedx-webhooks added this to Contributions Mar 17, 2026

github-project-automation bot moved this to Needs Triage in Contributions Mar 17, 2026

bradenmacdonald mentioned this pull request Mar 17, 2026

Add ContainerTypes to openedx-core [FC-0117] openedx/openedx-core#495

Open

kdmccormick added create-sandbox open-craft-grove should create a sandbox environment from this PR and removed create-sandbox open-craft-grove should create a sandbox environment from this PR labels Mar 19, 2026

kdmccormick requested changes Mar 19, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: update to work with latest openedx_content container changes [FC-0117]#38181

refactor: update to work with latest openedx_content container changes [FC-0117]#38181
bradenmacdonald wants to merge 1 commit intoopenedx:masterfrom
open-craft:braden/container-types-refactor

bradenmacdonald commented Mar 17, 2026

Uh oh!

openedx-webhooks commented Mar 17, 2026

Uh oh!

openedx-webhooks commented Mar 17, 2026

Uh oh!

kdmccormick left a comment

Uh oh!

kdmccormick Mar 19, 2026

Uh oh!

kdmccormick Mar 19, 2026

Uh oh!

kdmccormick Mar 19, 2026

Uh oh!

kdmccormick Mar 19, 2026

Uh oh!

kdmccormick Mar 19, 2026

Uh oh!

kdmccormick Mar 19, 2026 •

edited

Loading

Uh oh!

kdmccormick Mar 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	LIBRARY_ALLOWED_CONTAINER_TYPES = ["unit", "subsection", "section"]
	LIBRARY_ALLOWED_CONTAINER_TYPES = [Unit.type_code, Subsection.type_code, Section.type]

	# Deprecated - ambiguous type
	# Deprecated (ambiguously named). Identical to container_type_code.

		children = get_container_children(container_key, published=False)
		child_key_name = "usage_key" if isinstance(container, Unit) else "container_key"



		@dataclass(frozen=True, kw_only=True)
		class ContainerMetadata(PublishableItem):

Conversation

bradenmacdonald commented Mar 17, 2026

Description

Supporting information

Testing instructions

Deadline

Uh oh!

openedx-webhooks commented Mar 17, 2026

Uh oh!

openedx-webhooks commented Mar 17, 2026

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

kdmccormick Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

kdmccormick Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

kdmccormick Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

kdmccormick Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

kdmccormick Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

kdmccormick Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kdmccormick Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kdmccormick Mar 19, 2026 •

edited

Loading